Course Class Reference

List of all members.

Public Member Functions

Course ()

getPossibleAssistents ($courseID)

Static Public Member Functions

static changeToEcom ($courseID, $newModerator)

createCourse ($name, $shortName, $modulShortCut, $dozentID, $mni=false)

deleteCourse ($courseid)

archiveCourse ($courseID)

reactivateCourse ($courseID)

addParticipant ($userid, $courseid, $differentUsergroup=0)

getParticipants ($courseid, $roles="all", $orderBy="user.Nachname", $orderDir="ASC")

getRole ($userid, $courseid)

setAsAssistent ($userid, $courseid)

unsetAsAssistent ($userid, $courseid)

unsetAsTeacher ($userid, $courseid)

removeParticipant ($userid, $courseid)

getSemesterType ($semester)

getSemesterYear ($semester)

semesterDBtoString ($semester)

semesterStringToDB ($semester)

static getCheckOutNotice ($id)

static setCheckOutNotice ($value)

Member Function Documentation

Course::addParticipant	(	$	userid,
		$	courseid,
		$	differentUsergroup = `0`
	)			`[static]`

Fuegt einen Benutzer einer Veranstaltung hinzu. protected

Parameters:

	integer	$userid - ID des Benutzers
	integer	$courseid - ID der Veranstaltung
	integer	$differentUsergroup - Benutzergruppe, die der hinzugefügte User im Kurs einnehmen soll, 0 für die Gruppe, mit der er registriert ist

Returns:

bool - true, wenn Benutzer zu Veranstaltung hinzugefuegt

false, wenn Benutzer schon Teilnehmer ist oder Datenbankfehler auftrat

zum Ausführen automatischer Funktionen

Course::archiveCourse ( $ courseID ) [static]

Archiviert eine Veranstaltung. Teilnehmerliste erstellen und unter Ressourcen ablegen. Letzte Mitteilung generieren und per Mail verschicken. Alle Teilnehmer außer Dozenten und Tutoren ausschließen. Kurs schließen.

Author:: Clemens Weiß <clemens.weiss@mni.fh-giessen.de> protected

Parameters:

integer

$courseID - ID der Veranstaltung

Returns:: bool Erfolgswert

zum Ausführen automatischer Funktionen

static Course::changeToEcom	(	$	courseID,
		$	newModerator
	)			`[static]`

Course::Course ( )

Standard-Konstruktor. public

Returns:: void

Course::createCourse	(	$	name,
		$	shortName,
		$	modulShortCut,
		$	dozentID,
		$	mni = `false`
	)			`[static]`

Legt eine Veranstaltung in der Datenbank an. Hierbei werden nur die Pflichtfelder (ID, Name, Semester, DozentID) mit Werten gefuellt.

protected

Parameters:

	string	$name - Name der Veranstaltung
	string	$shortName - Kurzname der Veranstaltung
	string	$modulShortCut - Modulkürzel der Veranstaltung
	integer	$dozentID - ID des Dozenten
	integer	$mni - Gibt an, ob sich um eine MNI-Veranstaltung handelt

Returns:: integer - ID der angelegten Veranstaltung string - Fehlerbeschreibung, falls Veranstaltung nicht erzeugt werden konnte

zum Ausführen automatischer Funktionen

Course::deleteCourse ( $ courseid ) [static]

Loescht eine Veranstaltung. Es werden alle zu der Veranstaltung gehoerigen Daten aus den Tabellen 'courses' , 'user_course' und 'assistents' geloescht.

protected

Parameters:

integer

$courseid - ID der Veranstaltung, die geloescht werden soll

Returns:: bool true - wenn alle zur Veranstaltung gespeicherten Daten geloescht wurden false - wenn Fehler auftrat

zum Ausführen automatischer Funktionen

static Course::getCheckOutNotice ( $ id ) [static]

Course::getParticipants	(	$	courseid,
		$	roles = `"all"`,
		$	orderBy = `"user.Nachname"`,
		$	orderDir = `"ASC"`
	)			`[static]`

Liefert die zu einer Veranstaltung gehoerenden Teilnehmer.

public

Parameters:

	integer	$courseid - Id der Veranstaltung, deren Teilnehmer ermittelt werden sollen
	string	$roles - Filter fuer die Auswahl der Veranstaltungsteilnehmer moegliche Werte sind : 'teacher' - es werden nur die Dozenten der Veranst ausgew 'assistent' - nur Tutoren 'student' - nur Studenten 'wait' - Benutzer, die auf der Warteliste fuer die Veranstaltung stehen, aber noch keine Teilnehmer sind. 'all' - Zusammenfassung von 'teacher' , 'assistent' und 'student'
	string	$orderBy - DB-Tabellenspalte nach der sortiert werden soll. Default-Wert ist "user.Nachname".
	string	$orderDir - Richtung, in die sortiert werden soll. Default-Wert ist "DESC".

Returns:: mixed integer 0 - falls Fehler auftrat (z.B. keine Teilnehmer vorhanden ) object[] - Array mit Teilnehmerobjekten, die wie folgt aufgebaut sind: $participant->userid // Userid des Teilnehmers $participant->shortname // Kurzname des Teilnehmers $participant->firstname // Vorname des Teilnehmers $participant->lastname // Nachname des Teilnehmers $participant->email // Email-Adresse des Teilnehmers

Course::getPossibleAssistents ( $ courseID )

Course::getRole	(	$	userid,
		$	courseid
	)			`[static]`

Gibt die Rolle zurueck, die Benutzer in einer Veranstaltung einnimmt.

public

Parameters:

	integer	$userid - Id des Benutzers.
	integer	$courseid - Id der Veranstaltung.

Returns:: mixed string - Rolle des Benutzers in der Veranstaltung moegliche Werte sind : 'teacher' , 'assistent' , 'student' , 'wait' integer 0 - falls ungueltige Parameter, oder sonstiger Fehler.

Course::getSemesterType ( $ semester ) [static]

Extrahiert Semester-Typ aus Semesterstring in Datenbankformat.

public

Parameters:

integer

$semester - Semester in der Form "03WS"

Returns:: string - "WS" : falls Semester Wintersemester ist; "SS" : falls Semester Sommersemester ist.

Course::getSemesterYear ( $ semester ) [static]

Extrahiert das Jahr aus einem Semester.

public

Parameters:

integer

$semester - Semester in der Form "WS 03/04" oder "SS 04"

Returns:: string - Jahr des Semesters.

Course::reactivateCourse ( $ courseID ) [static]

Reaktiviert eine archivierte Veranstaltung. Kurs wieder öffnen. Anmeldezeitraum auf 90 Tage ab jetzt einstellen. Aktuelles Semester eintragen.

Author:: Clemens Weiß <clemens.weiss@mni.fh-giessen.de> protected

Parameters:

integer

$courseID - ID der Veranstaltung

Returns:: bool Erfolgswert

zum Ausführen automatischer Funktionen

Course::removeParticipant	(	$	userid,
		$	courseid
	)			`[static]`

Entfernt einen Benutzer aus einer Veranstaltung.

public

Parameters:

	integer	$userid - ID des Benutzers
	integer	$courseid - ID der Veranstaltung

Returns:: integer - 1, falls Teilnehmer aus Veranstaltung entfernt wurde 0, falls Teilnehmer nicht entfernt werden konnte.

zum Ausführen automatischer Funktionen

Course::semesterDBtoString ( $ semester ) [static]

Wandelt Semester im Datenbankformat in normales Format um.

public

Parameters:

string

$semester - Semester im Datenbankformat (Bsp.: "03WS")

Returns:: string - Semester in der Form "WS 03/04" bzw. "SS 04"

Course::semesterStringToDB ( $ semester ) [static]

Wandelt Semester in normalem Format in Datenbankformat um.

public

Parameters:

string

$semester - Semester in der Form "WS 03/04" bzw. "SS 04"

Returns:: string - Semester in Datenbankformat z.B. "03WS" , "03SS"

Course::setAsAssistent	(	$	userid,
		$	courseid
	)			`[static]`

Verleiht einem Benutzer das Tutorenrecht in einer Veranstaltung. Studenten werden in die 'assistents'-Tabelle uebernommen.
Hilfsadministratoren werden zusaetzlich in die 'user_course'-Tabelle uebernommen.

protected

Parameters:

	integer	$userid - ID des Benutzers
	integer	$courseid - ID der Veranstaltung

Returns:

bool - true, wenn Tutorenrecht verliehen oder Benutzer bereits Tutor in der Veranstaltung ist

false, wenn Datenbankfehler auftrat

zum Ausführen automatischer Funktionen

static Course::setCheckOutNotice ( $ value ) [static]

Course::unsetAsAssistent	(	$	userid,
		$	courseid
	)			`[static]`

Entzieht einem Benutzer das Tutorenrecht in einer Veranstaltung. Falls der Benutzer der Benutzergruppe Hilfsadministrator angehoert, wird er zusaetzlich aus der Veranstaltung entfernt.

protected

Parameters:

	integer	$userid - ID des Benutzers
	integer	$courseid - ID der Veranstaltung

Returns:: bool - true, wenn Tutorenrecht entzogen wurde false, wenn Fehler auftrat

zum Ausführen automatischer Funktionen

Course::unsetAsTeacher	(	$	userid,
		$	courseid
	)			`[static]`

Entzieht einem Benutzer das Dozentenrecht in einer Veranstaltung.

protected

Parameters:

	integer	$userid - ID des Benutzers
	integer	$courseid - ID der Veranstaltung

Returns:: bool - true, wenn Dozentenrecht entzogen wurde false, wenn Fehler auftrat

zum Ausführen automatischer Funktionen

The documentation for this class was generated from the following file:

web/courses/classes/class.Course.inc.php


Public Member Functions
	Course ()
	getPossibleAssistents ($courseID)
Static Public Member Functions
static	changeToEcom ($courseID, $newModerator)
	createCourse ($name, $shortName, $modulShortCut, $dozentID, $mni=false)
	deleteCourse ($courseid)
	archiveCourse ($courseID)
	reactivateCourse ($courseID)
	addParticipant ($userid, $courseid, $differentUsergroup=0)
	getParticipants ($courseid, $roles="all", $orderBy="user.Nachname", $orderDir="ASC")
	getRole ($userid, $courseid)
	setAsAssistent ($userid, $courseid)
	unsetAsAssistent ($userid, $courseid)
	unsetAsTeacher ($userid, $courseid)
	removeParticipant ($userid, $courseid)
	getSemesterType ($semester)
	getSemesterYear ($semester)
	semesterDBtoString ($semester)
	semesterStringToDB ($semester)
static	getCheckOutNotice ($id)
static	setCheckOutNotice ($value)